/* Copyright (c) 2010, Michael J. Allison

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, 
 this list of conditions and the following disclaimer.
 
 * Redistributions in binary form must reproduce the above copyright notice, 
 this list of conditions and the following disclaimer in the documentation 
 and/or other materials provided with the distribution.
 
 * Neither the name of Michael J. Allison nor the names of contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
 THE POSSIBILITY OF SUCH DAMAGE.
 */

package xamcommons.objectinspector;

/**
 * Description of a a field, with attributes. Used for comparison of 
 * FieldContainer fields. Used primarily in the CanonicalClass class.
 */
public class CanonicalField
{
   static public enum Requirement { OPTIONAL, REQUIRED } ;
   static public enum FieldStatus { OK, MISSING, ERROR, EXTRA };
   
   Requirement m_required;
   String      m_name;
   boolean     m_read_only;
   boolean     m_binding;
   String      m_type;
   
   public CanonicalField( Requirement required, 
                          String      name, 
                          boolean     readOnly, 
                          boolean     binding, 
                          String      type )
   {
      m_required  = required;
      m_name      = name;
      m_read_only = readOnly;
      m_binding   = binding;
      m_type      = type;
   }
   
   /**
    * Get the required state of the field.
    * @return The required enumeration of the cannonical field.
    */
   public Requirement getRequirement() { return m_required; }
   
   /**
    * Return regular expression name of the field.
    * @return The name
    */
   public String getName() { return m_name; }
   
   /**
    * Return the read only boolean value of the field. 
    * @return True if the field is to be read only, false otherwise.
    */
   public boolean getReadOnly() { return m_read_only; }
   
   /**
    * Return the binding boolean value of the field.
    * @return True if the field is bound, false otherwise. 
    */
   public boolean getBinding() { return m_binding; }
   
   /**
    * Get the MIME Content type describing the field.
    * @return The type string.
    */
   public String getType() { return m_type; } 
}
